feat: Unkey Laravel RBAC example #2439

harshsbhat · 2024-10-15T14:27:15Z

What does this PR do?

Showcases RBAC using Unkey and Laravel. This can help showcase Unkey's power using PHP and Laravel

Fixes: #2150

Github repo: https://github.com/harshsbhat/unkey-laravel-example

Summary by CodeRabbit

New Features
- Added a new project entry showcasing route protection using Unkey in a Laravel framework, contributed by Harsh Bhat.
- Included a link to the GitHub repository for the project.
Documentation
- Updated the "Your turn" section of the template document to reflect the new entry and contribution date.

changeset-bot · 2024-10-15T14:27:20Z

⚠️ No Changeset found

Latest commit: 34520ee

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

vercel · 2024-10-15T14:27:23Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 15, 2024 2:28pm

vercel · 2024-10-15T14:27:24Z

@harshsbhat is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

coderabbitai · 2024-10-15T14:27:25Z

📝 Walkthrough

Walkthrough

The pull request updates the oss.gg/7_create_a_template.md document by adding a new entry in the "Your turn" section. This entry highlights a project that implements route protection using Unkey within a Laravel framework, credited to Harsh Bhat, with a link to the GitHub repository. The addition is dated October 15, 2024, while the overall structure and requirements of the template remain unchanged.

Changes

File	Change Summary
`oss.gg/7_create_a_template.md`	Added new entry: `» 15-October-2024 by Harsh Bhat [Laravel RBAC route protection using unkey](https://github.com/harshsbhat/unkey-laravel-example)`

Assessment against linked issues

Objective	Addressed	Explanation
Add a new entry for contributions (#[2150])	✅

Possibly related PRs

feat: Unkey-flask template [SIDE QUEST] #2174: This PR adds a new entry for a Flask project by Harsh Bhat, which is related to route protection using Unkey, similar to the Laravel project added in the main PR.
chore: Unkey PDF Viewer template [SIDE QUEST] #2191: This PR includes a new entry for a PDF viewer template by Harsh Bhat, also showcasing a project using Unkey, which aligns with the theme of the main PR.
feat: Example app showcasing cost based unkey ratelimiting #2231: This PR adds a new entry for a project by Harsh Bhat on cost-based rate limiting, which is relevant as it continues the focus on Unkey implementations.
chore: Rust + Axum template [SIDE QUEST] #2237: This PR introduces a Rust + Axum project by Nazar Poshtarenko, which is another example of using Unkey for API protection, similar to the Laravel project in the main PR.
feat: Create a template with Unkey #2272: This PR expands the template creation section with various projects, including those by Harsh Bhat, which directly relates to the main PR's focus on contributions using Unkey.
feat: Unkey FastAPI boilerplate [SIDE QUEST] #2307: This PR adds a FastAPI boilerplate by Harsh Bhat, which is another framework showcasing Unkey, aligning with the main PR's theme of route protection.
chore: Next.js Pay-as-you-Go starter kit [SIDE QUEST] #2358: This PR introduces a Next.js starter kit that utilizes Unkey, further expanding the examples of Unkey implementations, similar to the Laravel project in the main PR.

Suggested labels

🕹️ oss.gg, :joystick: 750 points, hacktoberfest

Suggested reviewers

mcstepp
chronark
perkinsjr
MichaelUnkey

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between c6373b4 and 34520ee.

📒 Files selected for processing (1)

oss.gg/7_create_a_template.md (1 hunks)

🧰 Additional context used

🔇 Additional comments (1)

oss.gg/7_create_a_template.md (1)
42-42: New entry looks good, but let's verify a few things.

The new entry for the Laravel RBAC example is formatted correctly and aligns with the side quest requirements. However, let's verify a few points:

Ensure this is not a duplicate of an existing template on unkey.com/templates.

Confirm that the linked repository meets all the requirements:

It should be open source.

It should be MIT licensed.

It should have a README.md with a quickstart guide.

To verify these points, please run the following script:

Please review the script output to ensure all requirements are met.

✅ Verification successful

Verification Successful: All Checks Passed

No duplicate template found on unkey.com/templates.

Repository harshsbhat/unkey-laravel-example is public.

LICENSE file is present and is MIT licensed.

README.md contains a comprehensive Quickstart guide.
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Description: Verify the new entry and its linked repository

# Test 1: Check if the template already exists on unkey.com/templates
echo "Checking for duplicates on unkey.com/templates:"
curl -s https://www.unkey.com/templates | grep -i "Laravel RBAC route protection"

# Test 2: Check if the repository exists and is public
echo "Verifying repository:"
gh repo view harshsbhat/unkey-laravel-example

# Test 3: Check for LICENSE file
echo "Checking for LICENSE file:"
gh api repos/harshsbhat/unkey-laravel-example/contents/LICENSE

# Test 4: Check for README.md file
echo "Checking for README.md file:"
gh api repos/harshsbhat/unkey-laravel-example/contents/README.md

# Note: The actual content of LICENSE and README.md should be manually reviewed
# to ensure they meet the requirements (MIT license and quickstart guide).
Length of output: 9961

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

github-actions · 2024-10-15T14:27:30Z

Thank you for following the naming conventions for pull request titles! 🙏

chronark · 2024-10-29T13:36:32Z

/award 750

oss-gg · 2024-10-29T13:36:36Z

Awarding harshsbhat: 750 points 🕹️ Well done! Check out your new contribution on oss.gg/harshsbhat

feat: Unkey Laravel RBAC example

34520ee

harshsbhat requested review from perkinsjr, chronark, mcstepp and MichaelUnkey as code owners October 15, 2024 14:27

github-actions bot added hacktoberfest 🕹️ oss.gg labels Oct 15, 2024

vercel bot deployed to Preview – engineering October 15, 2024 14:28 View deployment

chronark closed this Oct 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Unkey Laravel RBAC example #2439

feat: Unkey Laravel RBAC example #2439

harshsbhat commented Oct 15, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Oct 15, 2024

vercel bot commented Oct 15, 2024 •

edited

Loading

vercel bot commented Oct 15, 2024

coderabbitai bot commented Oct 15, 2024 •

edited

Loading

Walkthrough

Changes

Assessment against linked issues

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

github-actions bot commented Oct 15, 2024 •

edited

Loading

chronark commented Oct 29, 2024

oss-gg bot commented Oct 29, 2024

feat: Unkey Laravel RBAC example #2439

feat: Unkey Laravel RBAC example #2439

Conversation

harshsbhat commented Oct 15, 2024 • edited by coderabbitai bot Loading

What does this PR do?

Summary by CodeRabbit

changeset-bot bot commented Oct 15, 2024

⚠️ No Changeset found

vercel bot commented Oct 15, 2024 • edited Loading

vercel bot commented Oct 15, 2024

coderabbitai bot commented Oct 15, 2024 • edited Loading

Walkthrough

Changes

Assessment against linked issues

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

github-actions bot commented Oct 15, 2024 • edited Loading

chronark commented Oct 29, 2024

oss-gg bot commented Oct 29, 2024

harshsbhat commented Oct 15, 2024 •

edited by coderabbitai bot

Loading

vercel bot commented Oct 15, 2024 •

edited

Loading

coderabbitai bot commented Oct 15, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions bot commented Oct 15, 2024 •

edited

Loading